// GtkSharp.Generation.OpaqueGen.cs - The Opaque Generatable.
//
// Author: Mike Kestner <mkestner@speakeasy.net>
//
// Copyright (c) 2001-2003 Mike Kestner
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of version 2 of the GNU General Public
// License as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this program; if not, write to the
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.


namespace GtkSharp.Generation {

	using System;
	using System.Collections;
	using System.IO;
	using System.Xml;

	public class OpaqueGen : HandleBase {

		public OpaqueGen(XmlElement ns, XmlElement elem) : base(ns, elem) { }

		public override string FromNative(string var, bool owned) {
			return var + " == IntPtr.Zero ? null : (" + QualifiedName + ") GLib.Opaque.GetOpaque (" + var + ", typeof (" + QualifiedName + "), " + (owned ? "true" : "false") + ")";
		}

		private bool DisableRawCtor {
			get {
				return Elem.GetAttributeAsBoolean("disable_raw_ctor");
			}
		}

		public override void Generate(GenerationInfo gen_info) {
			gen_info.CurrentType = QualifiedName;

			StreamWriter sw = gen_info.Writer = gen_info.OpenStream(Name, NS);

			sw.WriteLine("namespace " + NS + " {");
			sw.WriteLine();
			sw.WriteLine("\tusing System;");
			sw.WriteLine("\tusing System.Collections;");
			sw.WriteLine("\tusing System.Collections.Generic;");
			sw.WriteLine("\tusing System.Runtime.InteropServices;");
			sw.WriteLine();

			sw.WriteLine("#region Autogenerated code");

			SymbolTable table = SymbolTable.Table;

			Method ref_, unref, dispose, set_gvalue;
			GetSpecialMethods(out ref_, out unref, out dispose, out set_gvalue);

			if (IsDeprecated)
				sw.WriteLine("\t[Obsolete]");
			sw.Write("\t{0} partial {1}class " + Name, IsInternal ? "internal" : "public", IsAbstract ? "abstract " : String.Empty);
			string cs_parent = table.GetCSType(Elem.GetAttribute("parent"));
			if (cs_parent != "")
				sw.Write(" : " + cs_parent);
			else
				sw.Write(" : GLib.Opaque");

			foreach (string iface in managed_interfaces) {
				if (Parent != null && Parent.Implements(iface))
					continue;
				sw.Write(", " + iface);
			}

			sw.WriteLine(" {");
			sw.WriteLine();

			GenConstants(gen_info);
			GenFields(gen_info);
			GenMethods(gen_info, null, null);
			GenCtors(gen_info);

			if (ref_ != null) {
				ref_.GenerateImport(sw);
				sw.WriteLine("\t\tprotected override void Ref (IntPtr raw)");
				sw.WriteLine("\t\t{");
				sw.WriteLine("\t\t\tif (!Owned) {");
				sw.WriteLine("\t\t\t\t" + ref_.CName + " (raw);");
				sw.WriteLine("\t\t\t\tOwned = true;");
				sw.WriteLine("\t\t\t}");
				sw.WriteLine("\t\t}");
				sw.WriteLine();

				if (ref_.IsDeprecated) {
					sw.WriteLine("\t\t[Obsolete(\"" + QualifiedName + " is now refcounted automatically\")]");
					if (ref_.ReturnType == "void")
						sw.WriteLine("\t\tpublic void Ref () {}");
					else
						sw.WriteLine("\t\tpublic " + Name + " Ref () { return this; }");
					sw.WriteLine();
				}
			}

			// GtkWidgetPath has both gtk_widget_path_unref and gtk_widget_path_free
			// If this happens add only one and prefer unref over free
			bool disposeUnmanagedFuncAdded = false;

			if (unref != null) {
				unref.GenerateImport(sw);
				sw.WriteLine("\t\tprotected override void Unref (IntPtr raw)");
				sw.WriteLine("\t\t{");
				sw.WriteLine("\t\t\tif (Owned) {");
				sw.WriteLine("\t\t\t\t" + unref.CName + " (raw);");
				sw.WriteLine("\t\t\t\tOwned = false;");
				sw.WriteLine("\t\t\t}");
				sw.WriteLine("\t\t}");
				sw.WriteLine();
				sw.WriteLine("\t\tprotected override Action<IntPtr> DisposeUnmanagedFunc {");
				sw.WriteLine("\t\t\tget {");
				sw.WriteLine("\t\t\t\treturn " + unref.CName + ";");
				sw.WriteLine("\t\t\t}");
				sw.WriteLine("\t\t}");
				sw.WriteLine();
				disposeUnmanagedFuncAdded = true;
				if (unref.IsDeprecated) {
					sw.WriteLine("\t\t[Obsolete(\"" + QualifiedName + " is now refcounted automatically\")]");
					sw.WriteLine("\t\tpublic void Unref () {}");
					sw.WriteLine();
				}
			}

			if (dispose != null) {
				dispose.GenerateImport(sw);
				sw.WriteLine("\t\tprotected override void Free (IntPtr raw)");
				sw.WriteLine("\t\t{");
				sw.WriteLine("\t\t\t" + dispose.CName + " (raw);");
				sw.WriteLine("\t\t}");
				sw.WriteLine();
				if (!disposeUnmanagedFuncAdded) {
					sw.WriteLine("\t\tprotected override Action<IntPtr> DisposeUnmanagedFunc {");
					sw.WriteLine("\t\t\tget {");
					sw.WriteLine("\t\t\t\treturn " + dispose.CName + ";");
					sw.WriteLine("\t\t\t}");
					sw.WriteLine("\t\t}");
					sw.WriteLine();
				}

				if (dispose.IsDeprecated) {
					sw.WriteLine("\t\t[Obsolete(\"" + QualifiedName + " is now freed automatically\")]");
					sw.WriteLine("\t\tpublic void " + dispose.Name + " () {}");
					sw.WriteLine();
				}
			}


#if false
			Method copy = Methods ["Copy"] as Method;
			if (copy != null && copy.Parameters.Count == 0) {
				sw.WriteLine ("\t\tprotected override GLib.Opaque Copy (IntPtr raw)");
				sw.WriteLine ("\t\t{");
				sw.WriteLine ("\t\t\tGLib.Opaque result = new " + QualifiedName + " (" + copy.CName + " (raw));");
				sw.WriteLine ("\t\t\tresult.Owned = true;");
				sw.WriteLine ("\t\t\treturn result;");
				sw.WriteLine ("\t\t}");
				sw.WriteLine ();
			}
#endif
			if (set_gvalue != null) {
				sw.WriteLine("\t\t[DllImport(\"{0}\", CallingConvention = CallingConvention.Cdecl)]", LibraryName);
				sw.WriteLine("\t\tstatic extern void {0}(ref GLib.Value val, IntPtr obj);", set_gvalue.CName);
				sw.WriteLine();
				sw.WriteLine("\t\tpublic void SetGValue (ref GLib.Value val)");
				sw.WriteLine("\t\t{");
				sw.WriteLine("\t\t\t{0} (ref val, Handle);", set_gvalue.CName);
				sw.WriteLine("\t\t}");
				sw.WriteLine();
			}

			GenerateStructureABI(gen_info);
			sw.WriteLine("#endregion");

			sw.WriteLine("\t}");
			sw.WriteLine("}");

			sw.Close();
			gen_info.Writer = null;
			Statistics.OpaqueCount++;
		}

		void GetSpecialMethods(out Method ref_, out Method unref, out Method dispose, out Method set_gvalue) {
			ref_ = CheckSpecialMethod(GetMethod("Ref"));
			unref = CheckSpecialMethod(GetMethod("Unref"));

			dispose = GetMethod("Free");
			if (dispose == null) {
				dispose = GetMethod("Destroy");
				if (dispose == null)
					dispose = GetMethod("Dispose");
			}
			dispose = CheckSpecialMethod(dispose);

			set_gvalue = GetMethod("SetGValue");
			Methods.Remove("SetGValue");
		}

		Method CheckSpecialMethod(Method method) {
			if (method == null)
				return null;
			if (method.ReturnType != "void" &&
				method.ReturnType != QualifiedName)
				return null;
			if (method.Signature.ToString() != "")
				return null;

			Methods.Remove(method.Name);
			return method;
		}

		protected override void GenCtors(GenerationInfo gen_info) {
			if (!DisableRawCtor) {
				gen_info.Writer.WriteLine("\t\tpublic " + Name + "(IntPtr raw) : base(raw) {}");
				gen_info.Writer.WriteLine();
			}

			base.GenCtors(gen_info);
		}

	}
}